home *** CD-ROM | disk | FTP | other *** search
/ Mac Mania 4 / MacMania 4.toast / / Demo's / Igor Demo Pro / 1 PutContentsIn Igor Pro Folder / More Extensions / File Loaders / NILoadWave Documentation < prev    next >
Text File  |  1990-05-10  |  4KB  |  97 lines
  1. *** NILoadWave Documentation ***
  2.  
  3. NILoadWave is an Igor external operation that imports data from Nicolet files.
  4. It adds a menu item to Igor's Load Wave File... submenu for the NILoadWave
  5. operation.
  6.  
  7. NILoadWave loads Nicolet .WFT files but not .WFF files. It handles multi-
  8. segment files and waveforms with up to three zones. It does not handle
  9. .WFF files.
  10.  
  11. NOTE:
  12. We can't guarantee that NILoadWave will work with every Nicolet file,
  13. past, present or future.
  14.  
  15. To use NILoadWave, drag the NILoadWave XOP file into the folder that contains
  16. the Igor application. Then, launch Igor. The 'Load Waves' hierarchical menu
  17. in Igor's 'File' menu will have an item that says "Load Nicolet File". If you
  18. select this, NILoadWave will present you with a dialog. Select a Nicolet
  19. binary file from the dialog. NILoadWave will load the file, creating one
  20. or more Igor waves, depending on how many segments the Nicolet file has.
  21.  
  22. If the Nicolet file has more than one zone (timebase), NILoadWave also
  23. creates an "X wave" against which you can plot the wave or waves created
  24. from the data in the Nicolet file.
  25.  
  26. The Nicolet file may specify the name to be used for the waveforms in that
  27. file. NILoadWave tries to respect this. However, if the name specified in
  28. the file conflicts with the name of an Igor keyword, NILoadWave will give
  29. you a chance to specify a different name for the wave of waves created.
  30.  
  31. You can use the NILoadWave operation from Igor's command line or from
  32. an Igor macro as well as from the 'File' menu.
  33.  
  34. NILoadWave is called from Igor's command line as follows:
  35.         NILoadWave [/Q/O/D/I/A[=name]/N[=name]/P=path] ["fileName"]
  36.         
  37. where fileName is the name of the file to import. The fileName can be in
  38. a string variable as well a literal string. If you omit the filename or the
  39. path, NILoadWave will bring up the standard open dialog so that you can
  40. specify the file to load.
  41.     
  42. The name of loaded waves are derived from the name stored in the Nicolet
  43. file (the "waveform title" in Nicolet terminology), unless there is no name
  44. stored in the Nicolet file or you use the /A, /A=name, /N or /N=name flags.
  45. These are described below.
  46.  
  47. Since wave names can not contain blank spaces, NILoadWave changes blank
  48. spaces to underscore characters. It also shortens column names if necessary.
  49.     
  50. The flags are:
  51.     
  52.         /Q                 be quiet -- suppress normal diagnostic messages
  53.         /O                 overwrite existing waves of same name
  54.         /D                 make waves double precision
  55.         /I                  interactive -- use standard open dialog to get file name
  56.         /A                 assign wave names using "wave" as base
  57.         /A=name   assign wave names using "name" as base
  58.         /N                 like /A except reuses existing names
  59.         /N=name   like /A except reuses existing names
  60.         /P=path    use symbolic path plus fileName to find file
  61.         
  62. If "fileName" is omitted or /I is used it brings up the standard open dialog
  63. to get fileName.
  64.  
  65. If neither /A, /A=name, /N, /or N=name is used then the wave names come
  66. from the file or, if there is no waveform title in the file, the names of the
  67. form "wave0", "wave1", . . . are used.
  68.  
  69. If /A or /A=name is used then names of the form "wave0", "wave1" or "name0",
  70. "name1" are used where the digits are chosen to avoid conflicts with existing
  71. waves, variables or other names.
  72.  
  73. If /N or /N=name is used then names of the form "wave0", "wave1" or "name0",
  74. "name1" are used where the digits always start from zero and increment.
  75.     
  76. If the file has more than one zone, an X wave is made against which it can
  77. be graphed. The name of the X wave is the base name with _X appended to
  78. the end. A digit is appended to the name of the X wave to make it unique if
  79. the overwrite option (/O or /N) has not been specified.
  80.     
  81. For example:
  82.         NILoadWave /P=path "hd:Graphing:Test Data"
  83. would load the file "Test Data" from the folder "Graphing" on the disk "hd".
  84. It would base the wave names on the names stored in the file.
  85.  
  86. And,    
  87.     NILoadWave /D/N=DATA
  88. would bring up a standard open dialog to get the fileName, would generate
  89. wave names of the form "DATAn" where n is some number starting from zero,
  90. would overwrite waves with the same name and would make double
  91. precision waves.
  92.  
  93. NILoadWave sets the V_Flag variable to the number of waves loaded.
  94. It creates V_Flag if it does not already exist. It also sets the string variable
  95. S_Filename to the name of the file that was loaded, but only if S_Filename
  96. already exists.
  97.